/*
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 */
package erwiki.plugins;

import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;

import org.apache.commons.lang3.math.NumberUtils;
import org.apache.log4j.Logger;
import org.elwiki_data.PageReference;
import org.elwiki_data.WikiPage;
import org.osgi.framework.FrameworkUtil;

import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.PluginException;
import erwiki.api.plugin.PluginManager;
import erwiki.api.preferences.Preferences;
import erwiki.util.TextUtil;

/**
 * Плагин ErWiki. Отображает страницы, ссылающиеся на текущую страницу.
 * <p>
 * Параметры плагина:
 * <ul>
 * <li><b>id</b> - Идентификатор страницы. Значение по умолчанию – адресует текущую страницу вызова
 * плагина.</li>
 * <li><b>max</b> - Как много элементов вывести.</li>
 * <li><b>extras</b> - Как анонсировать дополнение, при превышении списка.</li>
 * </ul>
 *
 * Из {@link AbstractReferralPlugin}:
 * <ul>
 * <li><b>separator</b> - Разделитель сгенерированных ссылок; по умолчанию – разрыв строки
 * вики-текста, для создания вертикального списка.</li>
 * <li><b>maxwidth</b> - Максимальная ширина генерируемых ссылок, в символах.</li>
 * </ul>
 */
public class ReferringPagesPlugin extends AbstractReferralPlugin {

	private static final Logger log = Logger.getLogger(ReferringPagesPlugin.class);

	/** Имя параметра для выбора страницы по идентификатору. Значение <tt>{@value}</tt>. */
	public static final String PARAM_PAGE_ID = "id";

	/** Имя параметра задающего максимальное число выводимых элементов. Значение <tt>{@value}</tt>. */
	public static final String PARAM_MAX = "max";

	/**
	 * Имя параметра для настройки текста, который будет отображаться при превышении максимального
	 * количества элементов. Значение <tt>{@value}</tt>.
	 */
	public static final String PARAM_EXTRAS = "extras";

	/** {@inheritDoc} */
	@Override
	public String execute(WikiContext context, Map<String, String> params) throws PluginException {
		super.initialize(context, params);

		try {
			PluginManager pluginManager = m_engine.getManager(PluginManager.class);
			ResourceBundle rb = pluginManager.getBundle( //
					Preferences.getLocale(), FrameworkUtil.getBundle(this.getClass()));
			StringBuilder result = new StringBuilder(256);

			WikiPage page;

			/* Разбор параметров.
			 */
			String pageId = params.get(PARAM_PAGE_ID);
			page = (pageId == null) ? context.getPage() : pageManager.getPageById(pageId);
			if (page == null) {
				return "";
			}
			pageId = page.getId();

			int items = NumberUtils.toInt(params.get(PARAM_MAX), ALL_ITEMS);

			String extras = TextUtil.replaceEntities(params.get(PARAM_EXTRAS));
			if (extras == null) {
				extras = rb.getString("referringpagesplugin.more");
			}

			log.debug("Fetching referring pages for " + page.getName() + " with a max of " + items);

			/* Выполнить действительную работу.
			 */
			List<PageReference> inReferences;
			inReferences = pageManager.getPageReferrers(pageId);
			List<WikiPage> referrers = new ArrayList<>();
			for (PageReference pageReference : inReferences) {
				String pageId1 = pageReference.getWikipage().getId();
				WikiPage refPage = pageManager.getPageById(pageId1);
				if (refPage != null) {
					referrers.add(refPage);
				}
			}

			String wikitext;

			if (referrers != null && referrers.size() > 0) {
				// TODO: :FVK: rewrite code filterAndSortCollection() for WikiPages, PageReference...
				// old call:: links = filterAndSortCollection(links);
				wikitext = wikitizePageCollection(referrers, m_separator, items);

				result.append(makeHTML(context, wikitext));

				if (items < referrers.size() && items > 0) {
					Object[] args = { "" + (referrers.size() - items) };
					extras = MessageFormat.format(extras, args);

					result.append("<br />").append("<a class='morelink' href='")
							.append(context.getURL(WikiContext.PAGE_INFO, page.getName())).append("' ").append(">")
							.append(extras).append("</a><br />");
				}
			}

			//
			// Если после фильтрации или поиска ничего не осталось.
			//
			if (referrers == null || referrers.size() == 0) {
				wikitext = rb.getString("referringpagesplugin.nobody");

				result.append(makeHTML(context, wikitext));
			} else {
				if (m_show.equals(PARAM_SHOW_VALUE_COUNT)) {
					result = new StringBuilder();
					result.append(referrers.size());
					if (m_lastModified) {
						result.append(" (").append(m_dateFormat.format(m_dateLastModified)).append(")");
					}
				}
			}

			return result.toString();
		} catch (Exception e) {
			throw new PluginException(e);
		}
	}

}
